<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>headset.peripherals.PlaybackController.PlayBackController</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="headset-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >HeaDSET</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="headset-module.html">Package&nbsp;headset</a> ::
        <a href="headset.peripherals-module.html">Package&nbsp;peripherals</a> ::
        <a href="headset.peripherals.PlaybackController-module.html">Module&nbsp;PlaybackController</a> ::
        Class&nbsp;PlayBackController
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class PlayBackController</h1><p class="nomargin-top"><span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController">source&nbsp;code</a></span></p>
<center>
<center>  <map id="uml_class_diagram_for_headset__39" name="uml_class_diagram_for_headset__39">
<area shape="rect" href="headset.peripherals.PlaybackController.PlayBackController-class.html#BACKWARDS" title="headset.peripherals.PlaybackController.PlayBackController.BACKWARDS" alt="" coords="17,103,193,121"/>
<area shape="rect" href="headset.peripherals.PlaybackController.PlayBackController-class.html#STOP" title="headset.peripherals.PlaybackController.PlayBackController.STOP" alt="" coords="17,121,193,140"/>
<area shape="rect" href="headset.peripherals.PlaybackController.PlayBackController-class.html#FORWARD" title="headset.peripherals.PlaybackController.PlayBackController.FORWARD" alt="" coords="17,140,193,159"/>
<area shape="rect" href="headset.peripherals.PlaybackController.PlayBackController-class.html#MILI" title="headset.peripherals.PlaybackController.PlayBackController.MILI" alt="" coords="17,159,193,177"/>
<area shape="rect" href="headset.peripherals.PlaybackController.PlayBackController-class.html#MINI_STEP" title="headset.peripherals.PlaybackController.PlayBackController.MINI_STEP" alt="" coords="17,177,193,196"/>
<area shape="rect" href="headset.peripherals.PlaybackController.PlayBackController-class.html#__init__" title="Constructor." alt="" coords="17,199,193,217"/>
<area shape="rect" href="headset.peripherals.PlaybackController.PlayBackController-class.html#Start" title="Starts playing forward." alt="" coords="17,217,193,236"/>
<area shape="rect" href="headset.peripherals.PlaybackController.PlayBackController-class.html#Step" title="Move the recording one atom forward." alt="" coords="17,236,193,255"/>
<area shape="rect" href="headset.peripherals.PlaybackController.PlayBackController-class.html#Direction" title="Sets the direction of playback." alt="" coords="17,255,193,273"/>
<area shape="rect" href="headset.peripherals.PlaybackController.PlayBackController-class.html#SetPosition" title="Sets the current placyback position." alt="" coords="17,273,193,292"/>
<area shape="rect" href="headset.peripherals.PlaybackController.PlayBackController-class.html#GetDirection" title="Returns the current playback direction." alt="" coords="17,292,193,311"/>
<area shape="rect" href="headset.peripherals.PlaybackController.PlayBackController-class.html#GetPosition" title="Returns the current playback position" alt="" coords="17,311,193,329"/>
<area shape="rect" href="headset.peripherals.PlaybackController.PlayBackController-class.html#GetMax" title="Returns the number of atoms in the recording." alt="" coords="17,329,193,348"/>
<area shape="rect" href="headset.peripherals.PlaybackController.PlayBackController-class.html#Consume" title="Consumes a atom, and if it&#39;s not a oneshot will go the next, atom." alt="" coords="17,348,193,367"/>
<area shape="rect" href="headset.peripherals.PlaybackController.PlayBackController-class.html#Next" title="Goes to the next atom depending on direction and position." alt="" coords="17,367,193,385"/>
<area shape="rect" href="headset.peripherals.PlaybackController.PlayBackController-class.html#Stop" title="Stops the playback" alt="" coords="17,385,193,404"/>
<area shape="rect" href="headset.peripherals.PlaybackController.PlayBackController-class.html" title="The playback controller plays back recordings." alt="" coords="16,85,195,405"/>
<area shape="rect" href="headset.peripherals.InputController%27.InputController-class.html#GetName" title="Returns the name of the InputController." alt="" coords="37,36,173,55"/>
<area shape="rect" href="headset.peripherals.InputController%27.InputController-class.html" title="Wraps third party input." alt="" coords="36,11,175,56"/>
</map>
  <img src="uml_class_diagram_for_headset__39.gif" alt='' usemap="#uml_class_diagram_for_headset__39" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>The playback controller plays back recordings. Recordings can be 
  played back and be stepped trough. It uses the wrapping.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.peripherals.PlaybackController.PlayBackController-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">inputInterface</span>,
        <span class="summary-sig-arg">recording</span>)</span><br />
      Constructor.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.peripherals.PlaybackController.PlayBackController-class.html#_onTick" class="summary-sig-name" onclick="show_private();">_onTick</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">event</span>)</span><br />
      Tick mehod for the playback timer.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController._onTick">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.peripherals.PlaybackController.PlayBackController-class.html#Start" class="summary-sig-name">Start</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Starts playing forward.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController.Start">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.peripherals.PlaybackController.PlayBackController-class.html#Step" class="summary-sig-name">Step</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Move the recording one atom forward.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController.Step">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.peripherals.PlaybackController.PlayBackController-class.html#Direction" class="summary-sig-name">Direction</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span><br />
      Sets the direction of playback.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController.Direction">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.peripherals.PlaybackController.PlayBackController-class.html#SetPosition" class="summary-sig-name">SetPosition</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">index</span>)</span><br />
      Sets the current placyback position.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController.SetPosition">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.peripherals.PlaybackController.PlayBackController-class.html#GetDirection" class="summary-sig-name">GetDirection</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns the current playback direction.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController.GetDirection">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.peripherals.PlaybackController.PlayBackController-class.html#GetPosition" class="summary-sig-name">GetPosition</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns the current playback position</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController.GetPosition">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.peripherals.PlaybackController.PlayBackController-class.html#GetMax" class="summary-sig-name">GetMax</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns the number of atoms in the recording.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController.GetMax">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.peripherals.PlaybackController.PlayBackController-class.html#Consume" class="summary-sig-name">Consume</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">OneShot</span>)</span><br />
      Consumes a atom, and if it's not a oneshot will go the next, atom.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController.Consume">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.peripherals.PlaybackController.PlayBackController-class.html#Next" class="summary-sig-name">Next</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Goes to the next atom depending on direction and position.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController.Next">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.peripherals.PlaybackController.PlayBackController-class.html#Stop" class="summary-sig-name">Stop</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Stops the playback</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController.Stop">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="headset.peripherals.InputController%27.InputController-class.html">InputController'.InputController</a></code></b>:
      <code><a href="headset.peripherals.InputController%27.InputController-class.html#GetName">GetName</a></code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Class Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-ClassVariables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="headset.peripherals.PlaybackController.PlayBackController-class.html#BACKWARDS" class="summary-name">BACKWARDS</a> = <code title="-1">-1</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="headset.peripherals.PlaybackController.PlayBackController-class.html#STOP" class="summary-name">STOP</a> = <code title="0">0</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="headset.peripherals.PlaybackController.PlayBackController-class.html#FORWARD" class="summary-name">FORWARD</a> = <code title="1">1</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="headset.peripherals.PlaybackController.PlayBackController-class.html#MILI" class="summary-name">MILI</a> = <code title="1000">1000</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="headset.peripherals.PlaybackController.PlayBackController-class.html#MINI_STEP" class="summary-name">MINI_STEP</a> = <code title="30">30</code>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">inputInterface</span>,
        <span class="sig-arg">recording</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Constructor. A PlayBackController is always mapped to a single 
  recording.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>inputInterface</code></strong> - The wrapper for the model.</li>
        <li><strong class="pname"><code>recording</code></strong> - The recording that will be played back.</li>
    </ul></dd>
    <dt>Overrides:
        <a href="headset.peripherals.InputController%27.InputController-class.html#__init__">InputController'.InputController.__init__</a>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_onTick"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_onTick</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">event</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController._onTick">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Tick mehod for the playback timer.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="Start"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">Start</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController.Start">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Starts playing forward.</p>
  <dl class="fields">
    <dt>Overrides:
        <a href="headset.peripherals.InputController%27.InputController-class.html#Start">InputController'.InputController.Start</a>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="Step"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">Step</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController.Step">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Move the recording one atom forward.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="Direction"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">Direction</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">value</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController.Direction">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the direction of playback.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>value</code></strong> - The direction can FORWARD, PAUSE and BACKWARD</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="SetPosition"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">SetPosition</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">index</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController.SetPosition">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the current placyback position.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>index</code></strong> - The index of the current position.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="GetDirection"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">GetDirection</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController.GetDirection">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the current playback direction.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>Can be FORWARD, PAUSE and BACKWARD</dd>
  </dl>
</td></tr></table>
</div>
<a name="GetPosition"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">GetPosition</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController.GetPosition">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the current playback position</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>Index of the current atom.</dd>
  </dl>
</td></tr></table>
</div>
<a name="GetMax"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">GetMax</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController.GetMax">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the number of atoms in the recording.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>Number of atoms in recording.</dd>
  </dl>
</td></tr></table>
</div>
<a name="Consume"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">Consume</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">OneShot</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController.Consume">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Consumes a atom, and if it's not a oneshot will go the next, atom. A 
  oneshote call to this wil mean you only consume the current atom.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>OneShot</code></strong> - When true, will go to the next atom afterwards. When false will 
          stop after consuming atom.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="Next"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">Next</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController.Next">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Goes to the next atom depending on direction and position.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="Stop"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">Stop</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.peripherals.PlaybackController-pysrc.html#PlayBackController.Stop">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Stops the playback</p>
  <dl class="fields">
    <dt>Overrides:
        <a href="headset.peripherals.InputController%27.InputController-class.html#Stop">InputController'.InputController.Stop</a>
    </dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
<a name="section-ClassVariableDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Class Variable Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-ClassVariableDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="BACKWARDS"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">BACKWARDS</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
-1
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="STOP"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">STOP</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
0
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="FORWARD"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">FORWARD</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
1
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="MILI"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">MILI</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
1000
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="MINI_STEP"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">MINI_STEP</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
30
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="headset-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >HeaDSET</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    <a href="epydoc-log.html">Generated by Epydoc
    3.0.1 on Wed Feb 25 12:58:00 2009</a>
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
